bpo-34913: Document gzip command line interface#9782
Merged
JulienPalard merged 3 commits intopython:masterfrom Oct 10, 2018
Merged
bpo-34913: Document gzip command line interface#9782JulienPalard merged 3 commits intopython:masterfrom
JulienPalard merged 3 commits intopython:masterfrom
Conversation
tirkarthi
reviewed
Oct 10, 2018
Member
tirkarthi
left a comment
tirkarthi
left a comment
There was a problem hiding this comment.
Left a few minor nits. I will leave it to the reviewers to decide upon the wording. Thanks for the PR :)
Doc/library/gzip.rst
Outdated
|
|
||
| Once executed the :mod:`gzip` module keeps the input file(s). | ||
|
|
||
| .. versionadded:: 3.8 |
Member
There was a problem hiding this comment.
The command line interface was present in previous versions too. Maybe this can be changed to versionchanged to indicate argparse is used instead of manual parsing?
Doc/library/gzip.rst
Outdated
|
|
||
| .. cmdoption:: -d, --decompress | ||
|
|
||
| Uncompress the given file |
Member
There was a problem hiding this comment.
Can this be changed to decompress? I think it's more aligned with the command line argument being --decompress and also with other parts of the doc where decompress is used.
Doc/library/gzip.rst
Outdated
| ---------------------- | ||
|
|
||
| The :mod:`gzip` module provides a simple command line interface to compress or | ||
| uncompress files. |
Member
There was a problem hiding this comment.
Same here to use decompress instead of uncompress.
tirkarthi
approved these changes
Oct 10, 2018
Member
tirkarthi
left a comment
tirkarthi
left a comment
There was a problem hiding this comment.
LGTM. Thanks for making the changes :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue34913